/**
 * @class   wosh::communication::SessionProxy
 * @brief   The class represent and manage life of an IM (instant messaging)
 *          session.
 *
 * @see     wosh::Session
 * @see     wosh::SessionManager
 ****************************************************************************
 * @version $Id: SessionProxy.h 2891 2010-08-12 01:58:59Z alex $
 * @author  Alessandro Polo
 ****************************************************************************/
/* Copyright (c) 2007-2010, WOSH - Wide Open Smart Home 
 * by Alessandro Polo - OpenSmartHome.com
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the OpenSmartHome.com WOSH nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY Alessandro Polo ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL Alessandro Polo BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 ****************************************************************************/

#ifndef __WOSH_Communication_SessionIM_H__
 #define __WOSH_Communication_SessionIM_H__

 #include <core/Session.h>


namespace wosh {
 namespace communication {

class SessionProxy;

class ISessionProxyListener
 {
/** @name ISessionProxyListener Events
 * @{
 ******************************************************************************/
	public:
		virtual void session_registration( short reg_unreg, wosh::communication::SessionProxy* session ) = 0;
		virtual WRESULT session_print_message( const std::string& message, wosh::communication::SessionProxy* session ) = 0;

		virtual void session_state_changed( Session::SESSION_STATE new_state, Session::SESSION_STATE old_state, wosh::communication::SessionProxy* ) { (void)new_state; (void)old_state; }
		virtual void session_bus_changed( const std::string& , wosh::communication::SessionProxy* ) { }
		virtual void session_location_changed( const URI& , wosh::communication::SessionProxy* ) { }
//@}
	public:
		virtual ~ISessionProxyListener() { }

}; // class def


class SessionProxy : public wosh::Session
 {
	WOSH_SESSION(wosh::communication::SessionProxy)

	public:
		SessionProxy();
		virtual ~SessionProxy();

	public:
		using Session::login;
		using Session::parseInput;

/** @name Getters
 * @{
 ******************************************************************************/
	public:
		inline ISessionProxyListener* getListener()		{ return this->listener; }

//@}
/** name Setters
 * @{
 ******************************************************************************/
	public:
		inline void setListener( ISessionProxyListener* Listener )	{ this->listener = Listener; }

		using Session::setUsernameLogged;
		using Session::setCredentials;

		virtual WRESULT setState( SESSION_STATE value );
		virtual void setCurrentLocation( const URI& uri );
		virtual void setCurrentBus( const std::string& value );

//@}

	protected:
		virtual WRESULT printMessage( const std::string& message );

	protected:
		virtual void registered();
		virtual void unregistered();

	protected:
		ISessionProxyListener* listener;

}; // class def

 }; // namespace communication
}; // namespace wosh

#endif //__WOSH_Communication_SessionIM_H__
